home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat3 / Tk / bitmap.z / bitmap
Encoding:
Text File  |  2002-10-03  |  6.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4. bbbbiiiittttmmmmaaaapppp((((3333TTTTkkkk))))                                                        bbbbiiiittttmmmmaaaapppp((((3333TTTTkkkk))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      bitmap - Images that display two colors
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      iiiimmmmaaaaggggeeee ccccrrrreeeeaaaatttteeee bbbbiiiittttmmmmaaaapppp ?_n_a_m_e? ?_o_p_t_i_o_n_s?
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      A bitmap is an image whose pixels can display either of two colors or be
  17.      transparent.  A bitmap image is defined by four things:  a background
  18.      color, a foreground color, and two bitmaps, called the _s_o_u_r_c_e and the
  19.      _m_a_s_k.  Each of the bitmaps specifies 0/1 values for a rectangular array
  20.      of pixels, and the two bitmaps must have the same dimensions.  For pixels
  21.      where the mask is zero, the image displays nothing, producing a
  22.      transparent effect.  For other pixels, the image displays the foreground
  23.      color if the source data is one and the background color if the source
  24.      data is zero.
  25.  
  26.  
  27. CCCCRRRREEEEAAAATTTTIIIINNNNGGGG BBBBIIIITTTTMMMMAAAAPPPPSSSS
  28.      Like all images, bitmaps are created using the iiiimmmmaaaaggggeeee ccccrrrreeeeaaaatttteeee command.
  29.      Bitmaps support the following _o_p_t_i_o_n_s:
  30.  
  31.      ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd _c_o_l_o_r
  32.           Specifies a background color for the image in any of the standard
  33.           ways accepted by Tk.  If this option is set to an empty string then
  34.           the background pixels will be transparent.  This affect is achieved
  35.           by using the source bitmap as the mask bitmap, ignoring any
  36.           ----mmmmaaaasssskkkkddddaaaattttaaaa or ----mmmmaaaasssskkkkffffiiiilllleeee options.
  37.  
  38.      ----ddddaaaattttaaaa _s_t_r_i_n_g
  39.           Specifies the contents of the source bitmap as a string.  The string
  40.           must adhere to X11 bitmap format (e.g., as generated by the bbbbiiiittttmmmmaaaapppp
  41.           program).  If both the ----ddddaaaattttaaaa and ----ffffiiiilllleeee options are specified, the
  42.           ----ddddaaaattttaaaa option takes precedence.
  43.  
  44.      ----ffffiiiilllleeee _n_a_m_e
  45.           _n_a_m_e gives the name of a file whose contents define the source
  46.           bitmap.  The file must adhere to X11 bitmap format (e.g., as
  47.           generated by the bbbbiiiittttmmmmaaaapppp program).
  48.  
  49.      ----ffffoooorrrreeeeggggrrrroooouuuunnnndddd _c_o_l_o_r
  50.           Specifies a foreground color for the image in any of the standard
  51.           ways accepted by Tk.
  52.  
  53.      ----mmmmaaaasssskkkkddddaaaattttaaaa _s_t_r_i_n_g
  54.           Specifies the contents of the mask as a string.  The string must
  55.           adhere to X11 bitmap format (e.g., as generated by the bbbbiiiittttmmmmaaaapppp
  56.           program).  If both the ----mmmmaaaasssskkkkddddaaaattttaaaa and ----mmmmaaaasssskkkkffffiiiilllleeee options are
  57.           specified, the ----mmmmaaaasssskkkkddddaaaattttaaaa option takes precedence.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. bbbbiiiittttmmmmaaaapppp((((3333TTTTkkkk))))                                                        bbbbiiiittttmmmmaaaapppp((((3333TTTTkkkk))))
  71.  
  72.  
  73.  
  74.      ----mmmmaaaasssskkkkffffiiiilllleeee _n_a_m_e
  75.           _n_a_m_e gives the name of a file whose contents define the mask.  The
  76.           file must adhere to X11 bitmap format (e.g., as generated by the
  77.           bbbbiiiittttmmmmaaaapppp program).
  78.  
  79.  
  80. IIIIMMMMAAAAGGGGEEEE CCCCOOOOMMMMMMMMAAAANNNNDDDD
  81.      When a bitmap image is created, Tk also creates a new command whose name
  82.      is the same as the image.  This command may be used to invoke various
  83.      operations on the image.  It has the following general form:
  84.  
  85.           _i_m_a_g_e_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  86.  
  87.      _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command.  The
  88.      following commands are possible for bitmap images:
  89.  
  90.      _i_m_a_g_e_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n
  91.           Returns the current value of the configuration option given by
  92.           _o_p_t_i_o_n.  _O_p_t_i_o_n may have any of the values accepted by the iiiimmmmaaaaggggeeee
  93.           ccccrrrreeeeaaaatttteeee bbbbiiiittttmmmmaaaapppp command.
  94.  
  95.      _i_m_a_g_e_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  96.           Query or modify the configuration options for the image.  If no
  97.           _o_p_t_i_o_n is specified, returns a list describing all of the available
  98.           options for _i_m_a_g_e_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the
  99.           format of this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  100.           the command returns a list describing the one named option (this
  101.           list will be identical to the corresponding sublist of the value
  102.           returned if no _o_p_t_i_o_n is specified).  If one or more _o_p_t_i_o_n-_v_a_l_u_e
  103.           pairs are specified, then the command modifies the given option(s)
  104.           to have the given value(s);  in this case the command returns an
  105.           empty string.  _O_p_t_i_o_n may have any of the values accepted by the
  106.           iiiimmmmaaaaggggeeee ccccrrrreeeeaaaatttteeee bbbbiiiittttmmmmaaaapppp command.
  107.  
  108.  
  109. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  110.      bitmap, image
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.